Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve install docs #950

Merged
merged 6 commits into from
Sep 25, 2024
Merged

Improve install docs #950

merged 6 commits into from
Sep 25, 2024

Conversation

SimHoZebs
Copy link

The focus of these improvements are:

  • Reduce verbosity
  • Consistent formatting (e.g. steps are always in numbers)
  • Improve clarity (e.g. always start instruction steps with 'what' before 'why')
  • Add supporting links and missing instructions (e.g. migration warning)

Copy link
Contributor

@dmols dmols left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I mostly made suggestions based on small typos and areas that I feel more verbosity might be useful. Let me know what you think and thank you again for working on improving the documentation!

INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated

2. Open `.env` with a text editor and make the necessary changes to the following variables:
- `APP_ENV`: If you are setting up a development environment, change this to `dev` and follow the steps in [Installing Composer Dependencies](#installing-composer-dependencies) without the `--no-dev` flag to obtain all of the development packages. Otherwise, leave it as `prod`.
- `DATABASE_URL`: If you are hosting UDOIT on Docker or your local machine, leave it as it is. Otherwise, change it to your database URL.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `DATABASE_URL`: If you are hosting UDOIT on Docker or your local machine, leave it as it is. Otherwise, change it to your database URL.
- `DATABASE_URL`: If you are hosting UDOIT on Docker locally, leave it as it is. Otherwise, change it to your database URL.

This only works if Docker is running on your local machine, not either or. Same suggestion for the following two lines, but I'm good with any other similar changes!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If UDOIT is being hosted locally, doesn't that also mean the database is available too? Or are we seeing the database as a separate piece?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They should be separate, though I definitely misread what your comment was trying to say. Will make a small change and work on pushing this up to dev!

INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
@SimHoZebs SimHoZebs marked this pull request as ready for review August 29, 2024 18:02
@dmols dmols self-requested a review September 25, 2024 16:10
Copy link
Contributor

@dmols dmols left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The needed fixes were made, except for some minor styling changes I added recently. This PR is ready to merge. Thank you for helping us make the installation process read much easier, @SimHoZebs !

@dmols dmols merged commit e63d4da into ucfopen:dev Sep 25, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants